Get started

    API Endpoint

        http://IP-Address
        Result example :

        {
            "endpoint": "ready"
        }        
            

Endpoint IP Address

In Order to use WiFi Lan based API interface of Orvai devices (Plug and Power Strip), user must know the IP address of plug.

Orvai devices use DHCP to obtain IP address from router. It is recommended that you do MAC address binding in router so that router assign same IP address every time smart plug sends dhcp request to router.
You can watch video How to find MAC Address and assign fixed IP to Orvai devices

API Key

You can protect API access from unauthorized sources by using API Key. API Key is set to optional by default. User can set it to mandatory to protect from unauthorized access.

Please note if API Key is set to mandatory, you need to provide API Key in each request. If API Key is missing in request or does not match with the stored key, it will be considered a unauthorized attempt. A Maximum of 20 unauthorized attempts are allowed. Exceeding the max attempts will block access to device You will need physical access of device to reset apikey. You can watch video How to reset API Key on blocked device to factory default. The default api key set from factory is 1234567890987654321

Please make sure that if you make API Key mandatory, you remember it or note it down at some safe and secure place.

Following are 2 APIs exception to above rule that does not require API Key even if API Key is mandatory.

• GET APIKEY HINT
• GET APIKEY FLAG

GET STATUS

# Here is a curl example
curl -X GET "http://192.168.1.3/getstatus?swid=1&apikey=1234567890987654321"
                

This API is used to fetch the current status of a switch/plug on Orvai device. You need to make HTTP GET call to the following url :
http://IP-Address/getstatus

Result example :

{
    "result": "success",
    "status": 1
}
                

INPUT PARAMETERS (Format: Query String)

OUTPUT PARAMETERS (Format: Json)

SET STATUS

# Here is a curl example
curl -X GET "http://192.168.1.3/setstatus?swid=1&status=0&apikey=1234567890987654321"
                

This API is used to change the current status of a switch/plug on Orvai device. You need to make HTTP GET call to the following url :
http://IP-Address/setstatus

Result example :

{
    "result": "success"
}
                

INPUT PARAMETERS (Format: Query String)

OUTPUT PARAMETERS (Format: Json)

ADD SCHEDULE

# Here is a curl example
curl -X GET "http://192.168.1.3/addschedule?apikey=1234567890987654321&swid=2&hour=1&min=5&event=0&enabled=1&repeat=0&sun=0&mon=0&tue=0&wed=1&thu=0&fri=0&sat=0"
                

This API is used to add a schedule to specified switch/socket. Please note that non-repeatble schedules will be disabled automatically once executed and will remain in memory as disabled schedules. You need to make HTTP GET call to the following url :
http://IP-Address/addschedule

Result example :

{
    "result": "success",
}
                

INPUT PARAMETERS (Format: Query String)

OUTPUT PARAMETERS (Format: Json)

GET SCHEDULE

# Here is a curl example
curl -X GET "http://192.168.1.3/getschedule?apikey=1234567890987654321&swid=1"
                

This API is used to fetch schedules on specific switch/socket. You need to make HTTP GET call to the following url :
http://IP-Address/getschedule

Result example :

{
    "result": "success",
    "schedules": [
        {
            "swid": 1,
            "hour": 16,
            "min": 15,
            "event": 0,
            "enabled": 1,
            "repeat": 1,
            "sun": 1,
            "mon": 0,
            "tue": 1,
            "wed": 0,
            "thu": 1,
            "fri": 1,
            "sat": 0
        },
        {
            "swid": 1,
            "hour": 18,
            "min": 15,
            "event": 0,
            "enabled": 1,
            "repeat": 1,
            "sun": 1,
            "mon": 0,
            "tue": 1,
            "wed": 0,
            "thu": 1,
            "fri": 1,
            "sat": 0
        }
    ]
}

                

INPUT PARAMETERS (Format: Query String)

OUTPUT PARAMETERS (Format: Json)

DELETE SCHEDULE

# Here is a curl example
curl -X GET "http://192.168.1.3/deleteschedule?apikey=1234567890987654321&hour=1&min=5"
                

This API is used to delete a schedule based on scheduled time. You need to make HTTP GET call to the following url :
http://IP-Address/deleteschedule

Result example :

{
    "result": "success",
}
                

INPUT PARAMETERS (Format: Query String)

OUTPUT PARAMETERS (Format: Json)

DELETE ALL SCHEDULE

# Here is a curl example
curl -X GET "http://192.168.1.3/deleteallschedule?apikey=1234567890987654321"
                

This API is used to delete all the schedules on device. You need to make HTTP GET call to the following url :
http://IP-Address/deleteallschedule

Result example :

{
    "result": "success",
}
                

INPUT PARAMETERS (Format: Query String)

OUTPUT PARAMETERS (Format: Json)

SET CLOCK

# Here is a curl example
curl -X GET "http://192.168.1.3/setclock?apikey=1234567890987654321&c_day=4&c_hour=21&c_min=30&c_month=2&c_mday=12&c_sec=18"
                

This API is used to set clock on Orvai device (for schedules). After power reset device synchronizes its clock through internet. If internet is not available, then you need to set clock every time post power reset for successful schedule execution. This API can also help to synch time for any drift from actual time. You need to make HTTP GET call to the following url :
http://IP-Address/setclock

Result example :

{
    "result": "success",
}
                

INPUT PARAMETERS (Format: Query String)

OUTPUT PARAMETERS (Format: Json)

GET CLOCK

# Here is a curl example
curl -X GET "http://192.168.1.3/getclock?apikey=1234567890987654321"
                

This API is used to get current clock setting on the device. You need to make HTTP GET call to the following url :
http://IP-Address/getclock

Result example :

{
    "result": "success",
    "c_day": 4,
    "c_hour": 21,
    "c_min": 12,
    "c_sec": 12,
    "c_month": 1,
    "c_mday": 21
}

                

INPUT PARAMETERS (Format: Query String)

OUTPUT PARAMETERS (Format: Json)

GET POWER-UP STATE

# Here is a curl example
curl -X GET "http://192.168.1.3/getpowerupstate?apikey=1234567890987654321&swid=1"
                

This API is used to get behaviour of switch/socket on Power Cut/Resume. You need to make HTTP GET call to the following url :
http://IP-Address/getpowerupstate

Result example :

{
    "result": "success",
    "powerupstate": 2
}

                

INPUT PARAMETERS (Format: Query String)

OUTPUT PARAMETERS (Format: Json)

SET POWER-UP STATE

# Here is a curl example
curl -X GET "http://192.168.1.3/setpowerupstate?apikey=1234567890987654321&swid=1&powerupstate=2"
                

This API is used to set the behaviour of switch/socket on Power Cut/Resume. By default it is set to restore that means if you light was on before power cut device will restore it to ON on power resume. You can change the behavious using this api . You need to make HTTP GET call to the following url :
http://IP-Address/setpowerupstate

Result example :

{
    "result": "success",
}
                

INPUT PARAMETERS (Format: Query String)

OUTPUT PARAMETERS (Format: Json)

GET APIKEY FLAG

# Here is a curl example
curl -X GET "http://192.168.1.3/getkeyflag"
                

This API is used to know if the API Key is mandatory or optional. You need to make HTTP GET call to the following url :
http://IP-Address/getkeyflag

Result example :

{
    "result": "success",
    "keyflag": 0
}
                

INPUT PARAMETERS (Format: None)

No Input Parameeter is required

OUTPUT PARAMETERS (Format: Json)

SET APIKEY FLAG

# Here is a curl example
curl -X GET "http://192.168.1.3/setkeyflag?keyflag=0&apikey=1234567890987654321"
                

This API is used to make API Key mandatory or optional. You need to make HTTP GET call to the following url :
http://IP-Address/setkeyflag

Result example :

{
    "result": "success",
}
                

INPUT PARAMETERS (Format: Query String)

OUTPUT PARAMETERS (Format: Json)

GET APIKEY HINT

# Here is a curl example
curl -X GET "http://192.168.1.3/setstatus?swid=1&status=0&apikey=1234567890"
                

This API is used to provide only a hint to Api Key in which initial 2 and last 2 characters are displayed. There is no API to fetch full Key. In case genuine user forgets the key, this is the only option to get hint. In case brute force is used to find the key device access will be blocked forever after 20 attemps. This Api may be removed in furture upgrades. You need to make HTTP GET call to the following url :
http://IP-Address/getapikeyhint

Result example :

{
    "result": "success",
    "apikeyhint": "12xxxxxxxxxxxxxxx21"
}
                

INPUT PARAMETERS (Format: None)

No Input Parameeter is required

OUTPUT PARAMETERS (Format: Json)

SET APIKEY

# Here is a curl example
curl -X GET "http://192.168.1.3/setapikey?apikey=1234567890987654321&new_apikey=123456789987654321"
                

This API is used to change the current API Key. You need to make HTTP GET call to the following url :
http://IP-Address/setapikey

Result example :

{
    "result": "success",
}
                

INPUT PARAMETERS (Format: Query String)

OUTPUT PARAMETERS (Format: Json)